<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class DebugTimer</title>

	<script type="text/javascript" src="resources/combined.js?394153670"></script>
	<script type="text/javascript" src="elementlist.js?1800566221"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-abismo.html">abismo<span></span></a>
						<ul>
				<li><a href="package-abismo.admin.html">admin</a>
						</li>
				<li><a href="package-abismo.home.html">home</a>
						</li>
				<li><a href="package-abismo.images.html">images</a>
						</li>
				<li><a href="package-abismo.projects.html">projects</a>
						</li>
				<li><a href="package-abismo.Services.html">Services</a>
						</li>
				<li><a href="package-abismo.studio.html">studio</a>
						</li>
				<li><a href="package-abismo.tenders.html">tenders</a>
						</li>
				<li><a href="package-abismo.users.html">users</a>
						</li>
				<li><a href="package-abismo.videos.html">videos</a>
						</li>
				<li><a href="package-abismo.view.html">view<span></span></a>
						<ul>
				<li><a href="package-abismo.view.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-app.html">app<span></span></a>
						<ul>
				<li><a href="package-app.Config.html">Config<span></span></a>
						<ul>
				<li><a href="package-app.Config.Schema.html">Schema</a>
						</li>
							</ul></li>
				<li><a href="package-app.Model.html">Model<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.kit.html">kit</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-app.View.html">View<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.html">Helper<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li></ul></li></ul></li></ul></li>
				<li><a href="package-cake.html">cake<span></span></a>
						<ul>
				<li><a href="package-cake.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.panels.html">panels</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li class="active"><a href="package-debug.html">debug<span></span></a>
						<ul>
				<li class="active"><a href="package-debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-debug.kit.components.html">components</a>
						</li>
				<li><a href="package-debug.kit.controllers.html">controllers<span></span></a>
						<ul>
				<li><a href="package-debug.kit.controllers.components.html">components</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-debug.kit.Lib.html">Lib</a>
						</li>
				<li><a href="package-debug.kit.models.html">models<span></span></a>
						<ul>
				<li><a href="package-debug.kit.models.behaviors.html">behaviors</a>
						</li>
							</ul></li>
				<li><a href="package-debug.kit.vendors.html">vendors</a>
						</li>
				<li><a href="package-debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li><a href="package-localized.html">localized</a>
						</li>
				<li><a href="package-Localized.html">Localized<span></span></a>
						<ul>
				<li><a href="package-localized.tests.html">tests<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.html">cases<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.libs.html">libs</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-Localized.Validation.html">Validation</a>
						</li>
							</ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-DebugMemory.html">DebugMemory</a></li>
				<li class="active"><a href="class-DebugTimer.html">DebugTimer</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-debug.kit.Lib.html" title="Summary of debug\kit\Lib"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class DebugTimer</h1>











	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-debug.html">debug</a>\<a href="package-debug.kit.html">kit</a>\<a href="package-debug.kit.Lib.html">Lib</a><br />

				<b>Copyright:</b>
				Copyright 2005-2010, Cake Software Foundation, Inc. (<a
href="http://cakefoundation.org">http://cakefoundation.org</a>)<br />
				<b>License:</b>
				<a href="MIT">License (http://www.opensource.org/licenses/mit-license.php)</a><br />
		<b>Located at</b> <a href="source-class-DebugTimer.html#23-202" title="Go to source code">Plugin/DebugKit/Lib/DebugTimer.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="start" id="_start">

		<td class="attributes"><code>
			 public static
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_start">#</a>
		<code><a href="source-class-DebugTimer.html#32-71" title="Go to source code">start</a>( <span>string <var>$name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$message</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			
<p>Start an benchmarking timer.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Start an benchmarking timer.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name The name of the timer to start.</dd>
					<dt><var>$message</var></dt>
					<dd><code>string</code><br>$message A message for your timer</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br>true<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="stop" id="_stop">

		<td class="attributes"><code>
			 public static
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_stop">#</a>
		<code><a href="source-class-DebugTimer.html#73-109" title="Go to source code">stop</a>( <span>string <var>$name</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			
<p>Stop a benchmarking timer.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Stop a benchmarking timer.</p>

<p>$name should be the same as the $name used in startTimer().</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name The name of the timer to end.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br>true if timer was ended, false if timer was not started.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getAll" id="_getAll">

		<td class="attributes"><code>
			 public static
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getAll">#</a>
		<code><a href="source-class-DebugTimer.html#111-150" title="Go to source code">getAll</a>( <span>boolean <var>$clear</var> = <span class="php-keyword1">false</span></span> )</code>

		<div class="description short">
			
<p>Get all timers that have been started and stopped. Calculates elapsed time
for each timer. If clear is true, will delete existing timers</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get all timers that have been started and stopped. Calculates elapsed time
for each timer. If clear is true, will delete existing timers</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$clear</var></dt>
					<dd><code>boolean</code><br>$clear false</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="clear" id="_clear">

		<td class="attributes"><code>
			 public static
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_clear">#</a>
		<code><a href="source-class-DebugTimer.html#152-160" title="Go to source code">clear</a>( )</code>

		<div class="description short">
			
<p>Clear all existing timers</p>

		</div>

		<div class="description detailed hidden">
			
<p>Clear all existing timers</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br>true<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="elapsedTime" id="_elapsedTime">

		<td class="attributes"><code>
			 public static
			float
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_elapsedTime">#</a>
		<code><a href="source-class-DebugTimer.html#162-174" title="Go to source code">elapsedTime</a>( <span>mixed <var>$name</var> = <span class="php-quote">'default'</span></span>, <span>mixed <var>$precision</var> = <span class="php-num">5</span></span> )</code>

		<div class="description short">
			
<p>Get the difference in time between the timer start and timer end.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the difference in time between the timer start and timer end.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>mixed</code><br>$name string the name of the timer you want elapsed time for.</dd>
					<dt><var>$precision</var></dt>
					<dd><code>mixed</code><br>$precision int the number of decimal places to return, defaults to 5.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>float</code><br>number of seconds elapsed for timer name, 0 on missing key<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="requestTime" id="_requestTime">

		<td class="attributes"><code>
			 public static
			float
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_requestTime">#</a>
		<code><a href="source-class-DebugTimer.html#176-185" title="Go to source code">requestTime</a>( )</code>

		<div class="description short">
			
<p>Get the total execution time until this point</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the total execution time until this point</p>




				<h4>Returns</h4>
				<div class="list">
					<code>float</code><br>elapsed time in seconds since script start.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="requestStartTime" id="_requestStartTime">

		<td class="attributes"><code>
			 public static
			float
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_requestStartTime">#</a>
		<code><a href="source-class-DebugTimer.html#187-201" title="Go to source code">requestStartTime</a>( )</code>

		<div class="description short">
			
<p>get the time the current request started.</p>

		</div>

		<div class="description detailed hidden">
			
<p>get the time the current request started.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>float</code><br>time of request start<br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>












	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="_timers" id="$_timers">
		<td class="attributes"><code>
			protected static 
			array
		</code></td>

		<td class="name">
				<a href="source-class-DebugTimer.html#25-30" title="Go to source code"><var>$_timers</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$_timers" class="anchor">#</a>

			<div class="description short">
				
<p>Internal timers array</p>

			</div>

			<div class="description detailed hidden">
				
<p>Internal timers array</p>


			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
